.\"     Title: fldigi-shell
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\"      Date: 04/28/2009
.\"    Manual: 
.\"    Source: 
.\"
.TH "FLDIGI\-SHELL" "1" "04/28/2009" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
fldigi-shell - program for controlling fldigi
.SH "SYNOPSIS"
\fBfldigi\-shell\fR [\fIOPTIONS\fR] [\fIFILE\fR]
.sp
.SH "DESCRIPTION"
The fldigi\-shell program controls fldigi(1) over HTTP via XML\-encoded remote procedure calls (XML\-RPC)\. It can call any XML\-RPC method exported by fldigi, and also defines some useful commands of its own\.
.sp
.SH "OPTIONS"
.PP
\fB\-d\fR
.RS 4
Enable debug output\.
.RE
.PP
\fB\-u\fR \fIURL\fR
.RS 4
Use
\fIURL\fR
to access the server\. Defaults to \(lqhttp://localhost:7362/RPC2\(rq, which corresponds to fldigi\'s default listen address and port\.
.RE
.PP
\fB\-c\fR \fICOMMAND\fR
.RS 4
Execute command
\fICOMMAND\fR
and exit\.
.RE
.SH "COMMANDS"
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
Note
The \(lqx:yz\(rq notation refers to the return type and argument type(s)\. They are: \(lqn\(rq (nil), \(lqi\(rq (integer), and \(lqs\(rq (string)\.
.PP
debug (n:n:)
.RS 4
Toggle debug output\.
.RE
.PP
eval (s:s)
.RS 4
Evaluate Perl code\.
.RE
.PP
exit (n:n)
.RS 4
Exit the shell\.
.RE
.PP
help (n:n)
.RS 4
Print help for server (fldigi) methods and shell commands\.
.RE
.PP
history (s:n)
.RS 4
Print command history\.
.RE
.PP
modems (s:n)
.RS 4
List all modem names\.
.RE
.PP
poll (s:i)
.RS 4
Poll for new received text every
\fIi\fR
seconds\. Defaults to
\fI1\fR\.
.RE
.PP
pskrqsy (n:si)
.RS 4
QSY to
\fIi\fRth
best frequency for grid
\fIs\fR\. The list of frequencies is retrieved from the PSK Reporter website; see
\fBRESOURCES\fR\. The grid square string may be left empty, and the index argument defaults to
\fI0\fR
(first frequency)\.
.RE
.PP
recvtext (s:n)
.RS 4
Get all received text\.
.RE
.PP
reinit (n:n)
.RS 4
Fetch commands from the server and rebuild command list\.
.RE
.PP
send (n:s)
.RS 4
Send text interactively, one line at a time\.
.RE
.PP
sendchar (n:s)
.RS 4
Send text interactively, one character at a time\.
.RE
.PP
sendfile (n:s)
.RS 4
Send text read from file
\fIs\fR\.
.RE
.PP
sendstr (n:s)
.RS 4
Send string
\fIs\fR\.
.RE
.PP
source (n:s)
.RS 4
Read commands from file
\fIs\fR\.
.RE
.PP
time (s:s)
.RS 4
Time a command\.
.RE
.PP
wait (n:s)
.RS 4
Wait for server TRX state to become
\fIs\fR\.
.RE
.SH "EXTENDED DESCRIPTION"
The shell has three modes of operation:
.sp
.sp
.RS 4
\h'-04' 1.\h'+02'Interactive mode with history, tab completion and command line editing\. This is the default mode when fldigi\-shell is run without arguments\.
.RE
.sp
.RS 4
\h'-04' 2.\h'+02'Batch mode for a single command with the
\fB\-c\fR
option\.
.RE
.sp
.RS 4
\h'-04' 3.\h'+02'Batch mode to \(lqsource\(rq a file containing Perl code\. Fldigi\-shell commands can be called using \(lqexecute("COMMAND [ARG \&...]")\(rq calls\.
.RE
.SH "FILES"
.PP
$HOME/\.fldigi/shell\-history
.RS 4
Contains the fldigi\-shell command history\.
.RE
.SH "EXAMPLES"
.PP
while :; do fldigi\-shell \-c pskrqsy; sleep 900; done
.RS 4
Change to the \(lqbest frequency\(rq (see PSK Reporter) every fifteen minutes\.
.RE
.SH "SEE ALSO"
fldigi(1), xmlrpc(1), readline(3), RPC::XML(3pm)
.sp
.SH "BUGS"
.sp
.RS 4
\h'-04'\(bu\h'+03'Some additional command wrappers are needed\.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'Command completion should be enabled for the arguments of some commands\.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'The XML\-RPC handling code should probably go in a separate module\.
.RE
.sp
.RS 4
\h'-04'\(bu\h'+03'It should be possible to pass multiple
\fI\-c CMD\fR
arguments\.
.RE
.SH "RESOURCES"
Fldigi web site: http://www\.w1hkj\.com/Fldigi\.html
.sp
The PSK Automatic Propagation Reporter site can be found at http://www\.pskreporter\.info/
.sp
The GNU Readline Library: http://directory\.fsf\.org/project/readline/
.sp
XML\-RPC home page: http://www\.xmlrpc\.com/
.sp
.SH "AUTHOR"
Fldigi\-shell and this manual page were written by Stelios Bounanos, M0GLD <sb[at]enotty(dot)net>\.
.sp
.SH "COPYING"
License GPLv2+: GNU GPL version 2 or later\.
.sp
